package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.ProductBannerAddDTO;
import org.jsola.hr.dto.ProductBannerUpdateDTO;
import org.jsola.hr.query.ProductBannerQuery;
import org.jsola.hr.vo.ProductBannerListVO;
import org.jsola.hr.vo.ProductBannerVO;

import java.util.List;

/**
 * 产品banner
 *
 * @author zhr
 */
@Api(tags = "hr-产品banner")
public interface IProductBannerControllerAPI {

    /**
     * 新增产品banner
     *
     * @param productBannerAddDTO 产品banner新增实体
     * @return 产品banner展示对象
     */
    @ApiOperation(value = "新增产品banner")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerAddDTO", dataType = "ProductBannerAddDTO", value = "新增产品banner", paramType = "body")
    })
    Result<ProductBannerVO> save(ProductBannerAddDTO productBannerAddDTO);


    /**
     * 修改产品banner
     *
     * @param productBannerUpdateDTO 产品banner
     * @return 更新数量
     */
    @ApiOperation(value = "修改产品banner")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerUpdateDTO", dataType = "ProductBannerUpdateDTO", value = "修改产品banner", paramType = "body")
    })
    Result<Integer> update(ProductBannerUpdateDTO productBannerUpdateDTO);


    /**
     * 删除单个产品banner，彻底删除
     *
     * @param productBannerId 产品bannerid
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个产品banner，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerId", dataType = "Long", value = "产品bannerid", paramType = "path")
    })
    Result<Integer> delete(Long productBannerId);


    /**
     * 批量删除产品banner，彻底删除
     *
     * @param productBannerIds 产品bannerid集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除产品banner，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerIds", dataType = "Long[]", value = "产品bannerid数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] productBannerIds);


    /**
     * 根据产品bannerid查询产品banner详情
     *
     * @param productBannerId 产品bannerid
     * @return 产品banner详情
     */
    @ApiOperation(value = "根据产品bannerid查询产品banner详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerId", dataType = "Long", value = "产品bannerid", paramType = "path")
    })
    Result<ProductBannerVO> findById(Long productBannerId);


    /**
     * 查询产品banner
     *
     * @param productBannerQuery 产品banner查询参数
     * @return page
     */
    @ApiOperation(value = "查询产品banner")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerQuery", dataType = "ProductBannerQuery", value = "产品banner查询参数", paramType = "query")
    })
    Result<List<ProductBannerListVO>> listAll(ProductBannerQuery productBannerQuery);


    /**
     * 分页查询产品banner
     *
     * @param productBannerQuery 产品banner查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询产品banner")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "productBannerQuery", dataType = "ProductBannerQuery", value = "产品banner查询参数", paramType = "query")
    })
    Result<Page<ProductBannerListVO>> page(ProductBannerQuery productBannerQuery);

    /**
     * 查询租户下产品banner
     *
     * @return 产品banner列表
     */
    Result<List<ProductBannerListVO>> selectBySite();
}

